couchbase-lite-ee/kotbase/[android]CouchbaseLite/init

init

fun init(ctxt: Context)(source)

Initialize CouchbaseLite library. Unlike the Couchbase Lite Android SDK, this method is optional to call before using CouchbaseLite. The single-parameter CouchbaseLite.init(Context) will be called automatically by androidx-startup.

Parameters

ctxt

the ApplicationContext.

Throws

on initialization failure

@Internal(value = "This interface is not part of the public API")
fun init(ctxt: Context, debug: Boolean)(source)

Initialize CouchbaseLite library. Unlike the Couchbase Lite Android SDK, this method is optional to call before using CouchbaseLite. The single-parameter CouchbaseLite.init(Context) will be called automatically by androidx-startup.

Debugging mode is not supported for client code. Please use it only when advised to do so by Couchbase Support Engineering

Parameters

debug

true to enable debugging (Unsupported)

Throws

on initialization failure

@Internal(value = "This interface is not part of the public API")
fun init(ctxt: Context, debug: Boolean, rootDbDir: File, scratchDir: File)(source)

Initialize CouchbaseLite library.

Debugging mode is not supported for client code. Please use it only when advised to do so by Couchbase Support Engineering

This method allows specifying a default root directory for database files, and the scratch directory used for SQLite temporary files. Use it with great caution.

Parameters

ctxt

Application context

debug

to enable debugging (Unsupported)

rootDbDir

default directory for databases

scratchDir

scratch directory for SQLite

Throws

on initialization failure